AlteryxのAPI Outputツール

「カスタマーストーリー」を支えるツール特集

#ビッグデータ

#Alteryx

じょんすみす

2018.03.30

この記事は公開されてから1年以上経過しています。情報が古い可能性がありますので、ご注意ください。

こんにちは、小澤です。

今回は多くの方があまり利用されていないであろうAPI Outputツールの紹介をしたいと思います。

API Outputツールとは

Alteryxのツールには、API Outputツールというものがあります。

まずは、このツールはどういうことができるツールなのか簡単なワークフローで見ていきましょう。

入力データをAPI Outputツールに流しているだけです。本当にこれでいいのか？ってくらい簡単すぎるワークフローですね。

では、API Outputツールがどのような設定をしているのか見ていきましょう...と言いたいところですが、なんとこのツールには設定がありません! では、このツールは何をしたのでしょうか?その答えは、「Result」にあります。

このように、データがResultのMessageに表示されます。

どういう場面で使えるの?

どのような動きをするツールかわかりましたが、実際どういった場面で利用できるのでしょうか？ Messageにデータが出力されてもあまり嬉しくないように感じます。

このツールが効果を発揮するのはワークフローをAPIを使って利用するようなシーンになります。例えば、AlteryxのGalleryにはREST API経由でワークフローを実行する機能があります。

APIを使ったAlteryx Gallery(Server)へのアクセスについて｜ Developers.IO

APIツールを使っているワークフローを実行すると以下のような結果が得られます。

{
  "id": "5abdd81f7a4557075000161b",
  "appId": null,
  "createDate": "2018-03-30T06:24:31Z",
  "status": "Completed",
  "disposition": "Success",
  "outputs": [],
  "messages": [
    {
      "status": 1,
      "text": "Running at a Low Priority.",
      "toolId": -1
    },
    {
      "status": 8,
      "text": "_externals\\1\\iris.csv|150 records were read from \"_externals\\1\\iris.csv\"",
      "toolId": 1
    },
    ...
    ...
    {
      "status": 41,
      "text": "\"5.1\",\"3.5\",\"1.4\",\"0.2\",\"Iris-setosa\"",
      "toolId": 3
    },
    {
      "status": 41,
      "text": "\"4.9\",\"3\",\"1.4\",\"0.2\",\"Iris-setosa\"",
      "toolId": 3
    },
    ...
    ...
  ]
}

もちろん、出力結果のファイルをダウンロードするためのAPIというものも存在しますが、プログラムから使うことを考えると結果のJsonからそのままサクッと取得できるのはそれはそれで便利ですね。

このように、API Outputツールは外部から実行して結果を取得したいときに割と便利に使えます(こういった利用シーンと考えるとコーディング不要をうたうAlteryxではあまり使われないツールであることも頷けますねw)。